-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ChannelReader`1.xml
356 lines (353 loc) · 22.8 KB
/
ChannelReader`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<Type Name="ChannelReader<T>" FullName="System.Threading.Channels.ChannelReader<T>">
<TypeSignature Language="C#" Value="public abstract class ChannelReader<T>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ChannelReader`1<T> extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Threading.Channels.ChannelReader`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ChannelReader(Of T)" />
<TypeSignature Language="F#" Value="type ChannelReader<'T> = class" />
<TypeSignature Language="C++ CLI" Value="generic <typename T>
public ref class ChannelReader abstract" />
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="T">Specifies the type of data that may be read from the channel.</typeparam>
<summary>Provides a base class for reading from a channel.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ChannelReader ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ChannelReader();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.ChannelReader`1" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanCount">
<MemberSignature Language="C#" Value="public virtual bool CanCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanCount" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelReader`1.CanCount" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property CanCount As Boolean" />
<MemberSignature Language="F#" Value="member this.CanCount : bool" Usage="System.Threading.Channels.ChannelReader<'T>.CanCount" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanCount { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether <see cref="P:System.Threading.Channels.ChannelReader`1.Count" /> is available for use on this <see cref="T:System.Threading.Channels.ChannelReader`1" /> instance.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanPeek">
<MemberSignature Language="C#" Value="public virtual bool CanPeek { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanPeek" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelReader`1.CanPeek" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property CanPeek As Boolean" />
<MemberSignature Language="F#" Value="member this.CanPeek : bool" Usage="System.Threading.Channels.ChannelReader<'T>.CanPeek" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanPeek { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether <see cref="M:System.Threading.Channels.ChannelReader`1.TryPeek(`0@)" /> is available for use on this <see cref="T:System.Threading.Channels.ChannelReader`1" /> instance.</summary>
<value>
<see langword="true" /> if peeking is supported by this channel instance; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Completion">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task Completion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Threading.Tasks.Task Completion" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelReader`1.Completion" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Completion As Task" />
<MemberSignature Language="F#" Value="member this.Completion : System.Threading.Tasks.Task" Usage="System.Threading.Channels.ChannelReader<'T>.Completion" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Threading::Tasks::Task ^ Completion { System::Threading::Tasks::Task ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Threading.Tasks.Task" /> that completes when no more data will ever
be available to be read from this channel.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Count">
<MemberSignature Language="C#" Value="public virtual int Count { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelReader`1.Count" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Count As Integer" />
<MemberSignature Language="F#" Value="member this.Count : int" Usage="System.Threading.Channels.ChannelReader<'T>.Count" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property int Count { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current number of items available from this channel reader.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Counting is not supported on this instance.</exception>
</Docs>
</Member>
<Member MemberName="ReadAllAsync">
<MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IAsyncEnumerable<T> ReadAllAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IAsyncEnumerable`1<!T> ReadAllAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.ReadAllAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReadAllAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of T)" />
<MemberSignature Language="F#" Value="abstract member ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>
override this.ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>" Usage="channelReader.ReadAllAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1">
<AttributeName Language="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(System.Threading.Channels.ChannelReader<>+<ReadAllAsync>d__12))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(System.Threading.Channels.ChannelReader<>+<ReadAllAsync>d__12))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IAsyncEnumerable<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1">
<AttributeName Language="C#">[System.Runtime.CompilerServices.EnumeratorCancellation]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.EnumeratorCancellation>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="cancellationToken">The cancellation token to use to cancel the enumeration. If data is immediately ready for reading, then that data may be yielded even after cancellation has been requested.</param>
<summary>Creates an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that enables reading all of the data from the channel.</summary>
<returns>The created async enumerable.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Each <xref:System.Collections.Generic.IAsyncEnumerator%601.MoveNextAsync> call that returns `true` will read the next item out of the channel.
<xref:System.Collections.Generic.IAsyncEnumerator%601.MoveNextAsync> returns `false` once no more data is or will ever be available to read.
]]></format>
</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<Member MemberName="ReadAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask<T> ReadAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1<!T> ReadAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.ReadAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReadAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of T)" />
<MemberSignature Language="F#" Value="abstract member ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'T>
override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'T>" Usage="channelReader.ReadAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the read operation.</param>
<summary>Asynchronously reads an item from the channel.</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that represents the asynchronous read operation.</returns>
<remarks>If the operation is canceled, the operation will not have removed an item from the channel.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<Member MemberName="TryPeek">
<MemberSignature Language="C#" Value="public virtual bool TryPeek (out T item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryPeek([out] !T& item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.TryPeek(`0@)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function TryPeek (ByRef item As T) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryPeek : 'T -> bool
override this.TryPeek : 'T -> bool" Usage="channelReader.TryPeek item" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual bool TryPeek([Runtime::InteropServices::Out] T % item);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="item" Type="T" RefType="out" Index="0" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.1">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="item">The peeked item, or a default value if no item could be peeked.</param>
<summary>Attempts to peek at an item from the channel.</summary>
<returns>
<see langword="true" /> if an item was read; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryRead">
<MemberSignature Language="C#" Value="public abstract bool TryRead (out T item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryRead([out] !T& item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.TryRead(`0@)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function TryRead (ByRef item As T) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryRead : 'T -> bool" Usage="channelReader.TryRead item" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract bool TryRead([Runtime::InteropServices::Out] T % item);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="item" Type="T" RefType="out">
<Attributes>
<Attribute FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.1">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="item">The read item, or a default value if no item could be read.</param>
<summary>Attempts to read an item from the channel.</summary>
<returns>
<see langword="true" /> if an item was read; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WaitToReadAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask<bool> WaitToReadAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1<bool> WaitToReadAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelReader`1.WaitToReadAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function WaitToReadAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member WaitToReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<bool>" Usage="channelReader.WaitToReadAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(0)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the wait operation.</param>
<summary>Returns a <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete when data is available to read.</summary>
<returns>
<para>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete with a <see langword="true" /> result when data is available to read
or with a <see langword="false" /> result when no further data will ever be available to be read due to the channel completing successfully.</para>
<para>If the channel completes with an exception, the task will also complete with an exception.</para>
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
</Members>
</Type>